/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.basics.editor.gui.panel;

import com.genia.toolbox.basics.editor.gui.AbstractGUI;
import com.genia.toolbox.basics.editor.model.document.Document;
import com.genia.toolbox.basics.editor.model.document.Element;

/**
 * The abstract settings.
 * 
 * @param <G>
 *          The generic gui.
 * @param <D>
 *          The generic document.
 * @param <E>
 *          The generic element.
 */
@SuppressWarnings("serial")
public abstract class AbstractSettings<G extends AbstractGUI<?, ?, ?, D, E, ?>, D extends Document<E>, E extends Element<?>>
    extends AbstractPanel<G>
{

  /**
   * The document.
   */
  protected D document = null;

  /**
   * The element.
   */
  protected E element = null;



  /**
   * Constructor.
   * 
   * @param gui
   *          the application gui.
   */
  public AbstractSettings(G gui)
  {
    super(gui);
  }



  /**
   * Set the displayed document.
   * 
   * @param document
   *          the document.
   */
  public abstract void setDocument(D document);



  /**
   * Set the displayed element.
   * 
   * @param element
   *          the element.
   */
  public abstract void setElement(E element);



  /**
   * Get the displayed document.
   * 
   * @return the displayed document.
   */
  public abstract D getDocument();



  /**
   * Get the displayed element.
   * 
   * @return the displayed element.
   */
  public abstract E getElement();

}
